Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move documentation to puppet-strings #340

Merged
merged 1 commit into from
Apr 22, 2020

Conversation

baurmatt
Copy link
Contributor

@baurmatt baurmatt commented Apr 9, 2020

Pull Request (PR) description

I had some time during a meeting... ;)

This Pull Request (PR) fixes the following issues

Fixes #339.

@vox-pupuli-tasks
Copy link

Dear @baurmatt, thanks for the PR!

This is pccibot, your friendly Vox Pupuli GitHub Bot. I noticed that your pull request contains merge conflict. Can you please rebase?

You can find my sourcecode at voxpupuli/vox-pupuli-tasks

@dhoppe
Copy link
Member

dhoppe commented Apr 10, 2020

@baurmatt I appreciate the work you have done, but please follow the style guide:

For example, the new line after @param xyz is missing and you should keep an eye at the length of a line. It should be readable with any common editor.

Copy link
Member

@dhoppe dhoppe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should add the function assert_private(), too and add @api private to the puppet strings doc?

@baurmatt
Copy link
Contributor Author

Hey @dhoppe, thanks for taking a look! :) I've indeed found a couple of things which should be fixed (assert_private()/@api not used, different ways of getting the variables into the subclasses, inconsistent documentation strings, ...). I've explicitly decided against fixing it because the PR is already really huge.

@bastelfreak
Copy link
Member

I think this is a good first step, thanks for the work!

@dhoppe dhoppe merged commit dc35172 into voxpupuli:master Apr 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Convert dokumentation to puppet-strings
3 participants